Skip to content

Closes #114_vignette for UPSIT#121

Merged
jwang-lilly merged 5 commits intomainfrom
114_documentation_vignette_adnv
Jan 31, 2026
Merged

Closes #114_vignette for UPSIT#121
jwang-lilly merged 5 commits intomainfrom
114_documentation_vignette_adnv

Conversation

@jwang-lilly
Copy link
Copy Markdown
Collaborator

@jwang-lilly jwang-lilly commented Jan 21, 2026

Thank you for your Pull Request! We have developed this task checklist from the Development Process Guide to help with the final steps of the process. Completing the below tasks helps to ensure our reviewers can maximize their time on your code as well as making sure the admiral family codebase remains robust and consistent.

Please check off each taskbox as an acknowledgment that you completed the task or check off that it is not relevant to your Pull Request. This checklist is part of the Github Action workflows and the Pull Request will not be merged into the main branch until you have checked off each task.

  • Place Closes #<insert_issue_number> into the beginning of your Pull Request Title (Use Edit button in top-right if you need to update)
  • Code is formatted according to the tidyverse style guide. Run styler::style_file() to style R and Rmd files
  • Updated relevant unit tests or have written new unit tests, which should consider realistic data scenarios and edge cases, e.g. empty datasets, errors, boundary cases etc. - See Unit Test Guide
  • If you removed/replaced any function and/or function parameters, did you fully follow the deprecation guidance?
  • Update to all relevant roxygen headers and examples, including keywords and families. Refer to the categorization of functions to tag appropriate keyword/family.
  • Run devtools::document() so all .Rd files in the man folder and the NAMESPACE file in the project root are updated appropriately
  • Address any updates needed for vignettes and/or templates
  • Update NEWS.md under the header # admiral<ext> (development version) if the changes pertain to a user-facing function (i.e. it has an @export tag) or documentation aimed at users (rather than developers)
  • Build site pkgdown::build_site() and check that all affected examples are displayed correctly and that all new functions occur on the Reference page.
  • Address or fix all lintr warnings and errors - lintr::lint_package()
  • Run R CMD check locally and address all errors and warnings - devtools::check()
  • Link the issue in the Development Section on the right hand side.
  • Address all merge conflicts and resolve appropriately
  • Pat yourself on the back for a job well done! Much love to your accomplishment!

@jwang-lilly jwang-lilly changed the title Close #114_Created vignette for UPSIT Closes #114_Created vignette for UPSIT Jan 21, 2026
@jwang-lilly jwang-lilly linked an issue Jan 21, 2026 that may be closed by this pull request
@github-actions
Copy link
Copy Markdown

github-actions bot commented Jan 21, 2026

Code Coverage

Package Line Rate Health
admiralneuro 89%
Summary 89% (51 / 57)

@jwang-lilly jwang-lilly changed the title Closes #114_Created vignette for UPSIT Closes #114_vignette for UPSIT Jan 21, 2026
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds a new vignette documenting the creation of the ADNV (Nervous System Analysis Dataset) with a focus on UPSIT (University of Pennsylvania Smell Identification Test) olfactory function assessments.

Changes:

  • Created comprehensive vignette (vignettes/adnv.Rmd) demonstrating the workflow for building ADNV datasets, including UPSIT score to percentile conversion and criterion flag derivations
  • Updated the WORDLIST to include technical terms and proper nouns used in the new vignette

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
vignettes/adnv.Rmd New vignette providing step-by-step guidance for creating ADNV datasets with UPSIT-specific derivations
inst/WORDLIST Added medical/technical terms (α-synuclein, ADNV, AVALC, CSF, Lewy, 10th, Mastenbroek) for spell-checking

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread vignettes/adnv.Rmd Outdated
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Copy link
Copy Markdown

@mjiang-lilly mjiang-lilly left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks great!

@jwang-lilly
Copy link
Copy Markdown
Collaborator Author

@mjiang-lilly, could you please approve this PR?

@jwang-lilly jwang-lilly merged commit cb3d6a9 into main Jan 31, 2026
16 checks passed
@jwang-lilly jwang-lilly deleted the 114_documentation_vignette_adnv branch January 31, 2026 23:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Vignette adnv.Rmd for ADNV template

4 participants